Crate imgui

source ·

Re-exports

pub extern crate imgui_sys as sys;
pub use self::color::ImColor32;
pub use self::drag_drop::DragDropFlags;
pub use self::drag_drop::DragDropSource;
pub use self::drag_drop::DragDropTarget;
pub use self::draw_list::ChannelsSplit;
pub use self::draw_list::DrawListMut;
pub use self::text_filter::*;

Modules

Structs to create a Drag and Drop sequence. Almost all structs are re-exported and can be accessed from the crate root; some additional utilities can be found in here.
The draw list lets you create custom graphics within a window.
Internal raw utilities (don’t use unless you know what you’re doing!)

Macros

This is a macro used internally by imgui-rs to create StackTokens representing various global state in DearImGui.

Structs

Builder for an angle slider widget.
Backend capabilities
Flags for invisible buttons
Builder for a child window
Tracks a child window that can be ended by calling .end() or by dropping
Builder for a collapsing header widget
Builder for a color button widget.
Builder for a color editor widget.
Builder for a color editor widget.
Color edit flags
Builder for a color picker widget.
Examples
Tracks a color pushed to the color stack that can be popped by calling .end() or by dropping.
Builder for a combo box widget
Flags for combo boxes
Tracks a combo box that can be ended by calling .end() or by dropping.
Configuration flags
An imgui-rs context.
Starts a scope where interaction is disabled. Ends be calling .end() or when the token is dropped.
Builder for a drag slider widget.
Builder for a drag slider widget.
All draw data to render a Dear ImGui frame.
Draw command list
Iterator over draw lists
A single vertex
Non-functioning placeholder
Runtime data for a single font within a font atlas
A font atlas that builds a single texture
Font atlas configuration flags
Handle to a font atlas texture
Configuration settings for a font
A single font glyph
A set of Unicode codepoints
A font identifier
Tracks a font pushed to the font stack that can be popped by calling .end() or by dropping.
Tracks a layout group that can be ended with end or by dropping.
Unique ID used by widgets.
Tracks an ID pushed to the ID stack that can be popped by calling .pop() or by dropping. See crate::Ui::push_id for more details.
A UTF-8 encoded, implicitly nul-terminated string slice.
A UTF-8 encoded, growable, implicitly nul-terminated string.
Builder for an image widget
Builder for an image button widget
Builder for an input scalar widget.
Builder for an input scalar widget.
Callback flags for an InputText widget. These correspond to the general textflags.
Flags for text inputs
Callback flags for an InputTextMultiline widget. These correspond to the general textflags.
Settings and inputs/outputs for imgui-rs
Tracks a change pushed to the item flags stack.
Item hover check option flags
Builder for a list box widget
Tracks a list box that can be ended by calling .end() or by dropping
Used to render only the visible items when displaying a long list of items in a scrollable area.
Tracks a main menu bar that can be ended by calling .end() or by dropping
Tracks a menu bar that can be ended by calling .end() or by dropping
Builder for a menu item.
Tracks a menu that can be ended by calling .end() or by dropping
This is a Zst which implements TextCallbackHandler as a passthrough.
Create a modal pop-up.
Tracks a popup token that can be ended with end or by dropping.
Builder for a progress bar widget.
Builder for a selectable widget.
Flags for selectables
A font atlas that can be shared between contexts
Builder for a slider widget.
Flags for sliders
A wrapper around a slice of TableColumnSortSpecs.
User interface style/colors
Tracks a style pushed to the style stack that can be popped by calling .end() or by dropping.
A suspended imgui-rs context.
Builder for a tab bar.
Tracks a window that can be ended by calling .end() or by dropping
Tracks a tab bar item that can be ended by calling .end() or by dropping
Enum for [table_set_bg_color]. Background colors are rendering in 3 layers:
Flags for TableColumnSetup and [table_setup_column_with].
A struct containing all the data needed to setup a table column header via begin_table_header or table_setup_column.
Flags passed to begin_table methods.
Flags for [table_next_row_with_flags].
A wrapper around table sort specs.
Tracks a table which can be rendered onto, ending with .end() or by dropping.
This struct provides methods to edit the underlying text buffer that Dear ImGui manipulates. Primarily, it gives remove_chars, insert_chars, and mutable access to what text is selected.
An opaque texture identifier
Generic texture mapping for use by renderers.
Tracks a layout tooltip that can be ended by calling .end() or by dropping.
Builder for a tree node widget
Flags for tree nodes
Tracks a tree node that can be popped by calling .pop(), end(), or by dropping.
A reference for building the user interface for one frame
this is the unsafe cell upon which we build our abstraction.
Builder for a vertical slider widget.
Builder for a window
Configuration flags for windows
Window focus check option flags
Window hover check option flags
Tracks a window that can be ended by calling .end() or by dropping.

Enums

Color editor display mode.
Color editor input mode.
Color component formatting
Color picker hue/saturation/value editor mode
Color editor preview style
Combo box height mode.
Combo box preview mode.
Condition for applying a setting
A cardinal direction
A draw command
Target widget selection for keyboard focus
A source for binary font data
The arrow key a user pressed to trigger the on_history callback.
A temporary change in item flags
A key identifier
Represents one of the supported mouse buttons
Mouse cursor type identifier
An input identifier for navigation
A color identifier for styling.
A temporary change in user interface style
Unique ID used by tree nodes

Traits

Trait for clipboard backends
This trait provides an interface which ImGui will call on InputText and InputTextMultiline callbacks.

Functions

Returns the underlying Dear ImGui library version

Type Definitions

A vertex index